ugp.org.SerialX

Class Scope

java.lang.Object

ugp.org.SerialX.Scope

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<java.lang.Object>

Direct Known Subclasses:

JsonSelxUtils.JsonScope

public class Scope
extends java.lang.Object
implements java.lang.Iterable<java.lang.Object>, java.lang.Cloneable

This is some kind of hybrid between List and Map which allow you to have both variables and independent values managed by one Object.
Note: Variables are managed and accessed classically via Map methods such as put(String key, Object) and array of independent values is accessed by via List methods such as add(Object) and get(int)
This is used internally by Serializer and supposed to be read only!
Also this is java representation of SerialX Scope group such as:

 
 {
     //This is scope in SerialX!
 }
 
 

Author:

PETO

Constructor Summary

Constructors

Constructor and Description
Scope(java.util.Map<java.lang.String,java.lang.Object> variablesMap, java.util.Collection<java.lang.Object> values)
Scope(java.util.Map<java.lang.String,java.lang.Object> variablesMap, java.lang.Object... values)
Scope(java.lang.Object... values)

Method Summary

Modifier and Type	Method and Description
Scope	clone()
boolean	containsIndependentValue(java.lang.Object value)
boolean	containsVariable(java.lang.String variableName)
<T> Scope	filter(java.util.function.Predicate<T> predicate)
<T> Scope	filter(java.util.function.Predicate<T> predicate, boolean includeSubScopes)
<T> T	get(int valueIndex)
<T> T	get(java.lang.String variableName)
<T> T	get(java.lang.String variableName, T defaultValue)
boolean	getBool(int valueIndex)
boolean	getBool(java.lang.String variableName)
boolean	getBool(java.lang.String variableName, boolean defaultValue)
byte	getByte(int valueIndex)
byte	getByte(java.lang.String variableName)
byte	getByte(java.lang.String variableName, byte defaultValue)
double	getDouble(int valueIndex)
double	getDouble(java.lang.String variableName)
double	getDouble(java.lang.String variableName, double defaultValue)
float	getFloat(int valueIndex)
float	getFloat(java.lang.String variableName)
float	getFloat(java.lang.String variableName, float defaultValue)
char	getChar(int valueIndex)
char	getChar(java.lang.String variableName)
char	getChar(java.lang.String variableName, char defaultValue)
int	getInt(int valueIndex)
int	getInt(java.lang.String variableName)
int	getInt(java.lang.String variableName, int defaultValue)
long	getLong(int valueIndex)
int	getLong(java.lang.String variableName)
long	getLong(java.lang.String variableName, long defaultValue)
Scope	getParent()
Scope	getScope(int scopesOrderIndex)
Scope	getScope(java.lang.String... scopesPath)
Scope	getScopeAt(int scopeValueIndex)
short	getShort(int valueIndex)
short	getShort(java.lang.String variableName)
short	getShort(java.lang.String variableName, short defaultValue)
java.lang.String	getString(int valueIndex)
java.lang.String	getString(java.lang.String variableName)
java.lang.String	getString(java.lang.String variableName, java.lang.String defaultValue)
<T> T	getVarAt(int index)
<T> T	getVarAt(int index, T defaultValue)
boolean	isEmpty()
java.util.Iterator<java.lang.Object>	iterator()
<T> T	toObject(java.lang.Class<T> objClass)
<T> T	toObjectFrom(int scopesValueIndex, java.lang.Class<T> objClass)
<T> T	toObjectFrom(java.lang.String variableWithScope, java.lang.Class<T> objClass)
<T> T	toObjectFrom(java.lang.String variableWithScope, java.lang.Class<T> objClass, T defaultValue)
java.lang.String	toString()
java.lang.Object[]	toValArray()
java.util.List<java.lang.Object>	toValList()
java.util.LinkedHashMap<java.lang.String,java.lang.Object>	toVarMap()
<T> Scope	transform(java.util.function.Function<T,java.lang.Object> trans)
<T> Scope	transform(java.util.function.Function<T,java.lang.Object> trans, boolean includeSubScopes)
int	valuesCount()
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>	varEntrySet()
int	variablesCount()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Scope

@SafeVarargs
public Scope(java.lang.Object... values)

Parameters:

values - | Initial independent values to be added in to this scope!

Since:

1.2.0

Scope

@SafeVarargs
public Scope(java.util.Map<java.lang.String,java.lang.Object> variablesMap,
                           java.lang.Object... values)

Parameters:

variablesMap - | Initial variables to be added in to this scope!

values - | Initial independent values to be added in to this scope!

Since:

1.2.0

Scope

public Scope(java.util.Map<java.lang.String,java.lang.Object> variablesMap,
             java.util.Collection<java.lang.Object> values)

Parameters:

variablesMap - | Initial variables to be added in to this scope!

values - | Initial independent values to be added in to this scope!

Since:

1.2.0

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public Scope clone()

Overrides:

clone in class java.lang.Object

iterator

public java.util.Iterator<java.lang.Object> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.Object>

Returns:

Iterator of independent values.

Since:

1.2.0

getByte

public byte getByte(java.lang.String variableName)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Byte value of variable with name or 0 if there is no such a one! Byte will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getByte

public byte getByte(java.lang.String variableName,
                    byte defaultValue)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Byte value of variable with name or defaultValue if there is no such a one! Byte will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getShort

public short getShort(java.lang.String variableName)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Byte value of variable with name or 0 if there is no such a one! Byte will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getShort

public short getShort(java.lang.String variableName,
                      short defaultValue)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Byte value of variable with name or defaultValue if there is no such a one! Byte will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getInt

public int getInt(java.lang.String variableName)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Int value of variable with name or 0 if there is no such a one! Int will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getInt

public int getInt(java.lang.String variableName,
                  int defaultValue)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Int value of variable with name or defaultValue if there is no such a one! Int will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getLong

public int getLong(java.lang.String variableName)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Long value of variable with name or 0 if there is no such a one! Long will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getLong

public long getLong(java.lang.String variableName,
                    long defaultValue)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Long value of variable with name or defaultValue if there is no such a one! Long will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getFloat

public float getFloat(java.lang.String variableName)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Float value of variable with name or 0 if there is no such a one! Float will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getFloat

public float getFloat(java.lang.String variableName,
                      float defaultValue)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Float value of variable with name or defaultValue if there is no such a one! Float will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getDouble

public double getDouble(java.lang.String variableName)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Double value of variable with name or 0 if there is no such a one! Double will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getDouble

public double getDouble(java.lang.String variableName,
                        double defaultValue)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Double value of variable with name or defaultValue if there is no such a one! Double will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getString

public java.lang.String getString(java.lang.String variableName)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

String value of variable with name or null if there is no such a one! String will be also parsed from any object using Object.toString()!

Since:

1.2.5

getString

public java.lang.String getString(java.lang.String variableName,
                                  java.lang.String defaultValue)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

String value of variable with name or defaultValue if there is no such a one! String will be also parsed from any object using Object.toString()!

Since:

1.2.5

getChar

public char getChar(java.lang.String variableName)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Char value of variable with name or (char) 0 if there is no such a one! Char will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getChar

public char getChar(java.lang.String variableName,
                    char defaultValue)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Char value of variable with name or defaultValue if there is no such a one! Char will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getBool

public boolean getBool(java.lang.String variableName)

Parameters:

variableName - | Variables name.

Returns:

Boolean value of variable with name or false if there is no such a one! Boolean will be also parsed from Number, or CharSequence if possible!

Since:

1.2.5

getBool

public boolean getBool(java.lang.String variableName,
                       boolean defaultValue)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Boolean value of variable with name or defaultValue if there is no such a one! Boolean will be also parsed from Number, or CharSequence if possible!

Since:

1.2.5

getVarAt

public <T> T getVarAt(int index)

Parameters:

index - | Index of variable!

Returns:

Value of variable at required index or null if index was not found!

Since:

1.2.5

getVarAt

public <T> T getVarAt(int index,
                      T defaultValue)

Parameters:

index - | Index of variable!

defaultValue - | Default value to return.

Returns:

Value of variable at required index or defaultValue if index was not found!

Since:

1.2.5

get

public <T> T get(java.lang.String variableName)

Parameters:

variableName - | Variables name.

Returns:

Value of variable with name or null if there is no such a one!

Since:

1.2.0

get

public <T> T get(java.lang.String variableName,
                 T defaultValue)

Parameters:

variableName - | Variables name.

defaultValue - | Default value to return.

Returns:

Value of variable with name or defaultValue if there is no such a one!

Since:

1.2.5

containsVariable

public boolean containsVariable(java.lang.String variableName)

Parameters:

variableName - | Variables name to search for.

Returns:

True if variable with given name was found in this scope.

Since:

1.2.0

containsIndependentValue

public boolean containsIndependentValue(java.lang.Object value)

Parameters:

value - | Objecthe value.

Returns:

True if independent value was found in this scope.

Since:

1.2.0

getByte

public byte getByte(int valueIndex)

Parameters:

valueIndex - | Index of independent value. Also can be negative, in this case u will get elements from back! IndexOutOfBoundsException will be thrown if index is too big!

Returns:

Independent byte value with valueIndex. Byte will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getShort

public short getShort(int valueIndex)

Parameters:

valueIndex - | Index of independent value. Also can be negative, in this case u will get elements from back! IndexOutOfBoundsException will be thrown if index is too big!

Returns:

Independent short value with valueIndex. Byte will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getInt

public int getInt(int valueIndex)

Parameters:

valueIndex - | Index of independent value. Also can be negative, in this case u will get elements from back! IndexOutOfBoundsException will be thrown if index is too big!

Returns:

Independent int value with valueIndex. Int will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getLong

public long getLong(int valueIndex)

Parameters:

valueIndex - | Index of independent value. Also can be negative, in this case u will get elements from back! IndexOutOfBoundsException will be thrown if index is too big!

Returns:

Independent long value with valueIndex. Long will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getFloat

public float getFloat(int valueIndex)

Parameters:

valueIndex - | Index of independent value. Also can be negative, in this case u will get elements from back! IndexOutOfBoundsException will be thrown if index is too big!

Returns:

Independent float value with valueIndex. Float will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getDouble

public double getDouble(int valueIndex)

Parameters:

valueIndex - | Index of independent value. Also can be negative, in this case u will get elements from back! IndexOutOfBoundsException will be thrown if index is too big!

Returns:

Independent double value with valueIndex. Double will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getString

public java.lang.String getString(int valueIndex)

Parameters:

valueIndex - | Index of independent value. Also can be negative, in this case u will get elements from back! IndexOutOfBoundsException will be thrown if index is too big!

Returns:

Independent string value with valueIndex. String will be also parsed from any object using Object.toString()!

Since:

1.2.5

getChar

public char getChar(int valueIndex)

Parameters:

valueIndex - | Index of independent value. Also can be negative, in this case u will get elements from back! IndexOutOfBoundsException will be thrown if index is too big!

Returns:

Independent char value with valueIndex. Char will be also parsed from Number, Character or CharSequence if possible!

Since:

1.2.5

getBool

public boolean getBool(int valueIndex)

Parameters:

valueIndex - | Index of independent value. Also can be negative, in this case u will get elements from back! IndexOutOfBoundsException will be thrown if index is too big!

Returns:

Independent boolean value with valueIndex. Boolean will be also parsed from Number, or CharSequence if possible!

Since:

1.2.5

get

public <T> T get(int valueIndex)

Parameters:

valueIndex - | Index of independent value. Also can be negative, in this case u will get elements from back! IndexOutOfBoundsException will be thrown if index is too big!

Returns:

Independent value with valueIndex.

Since:

1.2.0

getScopeAt

public Scope getScopeAt(int scopeValueIndex)

Parameters:

scopeValueIndex - | Index of sub-scopes value.

Returns:

Sub-scope on required index or null if there is no scope on required index!
Note: Keep in mind that you need to insert valid index according to other values. Scopes share same index order with other values!

Since:

1.2.0

getScope

public Scope getScope(int scopesOrderIndex)

Parameters:

scopesOrderIndex - | Order index of sub-scope.

Returns:

Sub-scope with required number. Similar to getScopeAt(int) however this will ignore non scope variables.

For instance getScope(1) in context:

 
 variable = "something";
 "something";
 {
      "Scope0"
 };
 123;
 null;
 {
      "Scope1" <- This one will be returned!

 };
 4;
 5;
 6;
 {
      "Scope2"
 }
 
 

Since:

1.2.0

getScope

public Scope getScope(java.lang.String... scopesPath)

Parameters:

scopesPath - | Array with variable names creating path to required scope.

Returns:

Sub-scope stored by variable with required name (last element) in inserted path or null if there is no such a one in inserted path. If there is more than one result, the first one found will be returned! This search will also includes sub-scopes of scope but variables from lower ones are prioritize!
If this function is called with no arguments then self will be returned!

 
 variable = "something";
 scope1 = 
 {
      subScope = 
      {
          scopeObjectoFind = {...}; <- this one will be returned if getScope("scope1", "scopeObjectoFind") is issued!
          7;...
      }
 };
 scopeObjectoFind = {...} <- this one will be returned if getScope("scopeObjectoFind") is issued!
 
 

Note: Remember that this search includes variables only, no values!

Since:

1.2.0

toObjectFrom

public <T> T toObjectFrom(int scopesValueIndex,
                          java.lang.Class<T> objClass)
                   throws java.lang.Exception

Parameters:

scopesValueIndex - | Index of independent value. Also can be negative, in this case u will get elements from back! IndexOutOfBoundsException will be thrown if index is too big!

objClass - | Object of class to create.

Returns:

Object of objClass constructed from independent value with scopesValueIndex! If there is no Scope stored at scopesValueIndex this function behaves same as get(int)! If independent value is Scope like it supposed to, then values of scope are parsed to SerializationProtocol of objClass. Note: Scopes are searched via regular independent value index no scope index like getScope(int).

Throws:

java.lang.Exception - if Exception occurred in SerializationProtocol.unserialize(Class, Object...)!

Since:

1.2.5

See Also:

Serializer.PROTOCOL_REGISTRY, toObject(Class)

toObjectFrom

public <T> T toObjectFrom(java.lang.String variableWithScope,
                          java.lang.Class<T> objClass)
                   throws java.lang.Exception

Parameters:

variableWithScope - | Variable that supposed to contains scope.

objClass - | Object of class to create.

Returns:

Value of variable with name or null if there is no such a one! If there is no Scope stored by variableWithScope this function behaves same as get(String, Object)! If variableWithScope contains Scope like it supposed to, then values of scope are parsed to SerializationProtocol of objClass.

Throws:

java.lang.Exception - if Exception occurred in SerializationProtocol.unserialize(Class, Object...)!

Since:

1.2.5

See Also:

Serializer.PROTOCOL_REGISTRY, toObject(Class)

toObjectFrom

public <T> T toObjectFrom(java.lang.String variableWithScope,
                          java.lang.Class<T> objClass,
                          T defaultValue)
                   throws java.lang.Exception

Parameters:

variableWithScope - | Variable that supposed to contains scope.

objClass - | Object of class to create.

defaultValue - | Default value to return.

Returns:

Value of variable with name or defaultValue if there is no such a one! If there is no Scope stored by variableWithScope this function behaves same as get(String, Object)! If variableWithScope contains Scope like it supposed to, then values of scope are parsed to SerializationProtocol of objClass.

Throws:

java.lang.Exception - if Exception occurred in SerializationProtocol.unserialize(Class, Object...)!

Since:

1.2.5

See Also:

Serializer.PROTOCOL_REGISTRY, toObject(Class)

toObject

public <T> T toObject(java.lang.Class<T> objClass)
               throws java.lang.Exception

Parameters:

objClass - | Object of class to create.

Returns:

Object of objClass constructed from this scope using protocol for objClass or null if there was no protocol found in Serializer.PROTOCOL_REGISTRY!

Throws:

java.lang.Exception - | Exception if Exception occurred in SerializationProtocol.unserialize(Class, Object...)!

Since:

1.2.5

filter

public <T> Scope filter(java.util.function.Predicate<T> predicate)

Parameters:

predicate - | Predicate object with filter condition in test method!

Returns:

Original scope after filtration using inserted predicate! If some object can't be casted to Predicate.test(Object) argument, it will be treated as invalid and will be filtered away! Sub-scopes are not included!

Since:

1.2.5

filter

public <T> Scope filter(java.util.function.Predicate<T> predicate,
                        boolean includeSubScopes)

Parameters:

predicate - | Predicate object with filter condition in test method!

includeSubScopes - | If true filtration will be also applied on sub-scopes, if false sub-scopes will be treated as other things (parsed in to Predicate.test(Object)). If sub-scope is empty after filtration it will not be included in result!

Returns:

Original scope after filtration using inserted predicate! If some object can't be casted to Predicate.test(Object) argument, it will be treated as invalid and will be filtered away!

Since:

1.2.5

transform

public <T> Scope transform(java.util.function.Function<T,java.lang.Object> trans)

Parameters:

trans - | Function to transform objects of this scope!

Returns:

Original scope after transformation using inserted function! If some object can't be casted to Function.apply(Object) argument, it will be treated as invalid and will be filtered away! Sub-scopes are not included!

Since:

1.2.5

transform

public <T> Scope transform(java.util.function.Function<T,java.lang.Object> trans,
                           boolean includeSubScopes)

Parameters:

trans - | Function to transform objects of this scope!

includeSubScopes - | If true transformation will be also applied on sub-scopes, if false sub-scopes will be treated as other things (parsed in to Function.apply(Object)). If sub-scope is empty after transformation it will not be included in result!

Returns:

Original scope after transformation using inserted function! If some object can't be casted to Function.apply(Object) argument, it will be treated as invalid and will be filtered away!

Since:

1.2.5

varEntrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> varEntrySet()

Returns:

Entry set of variables!

Since:

1.2.0

valuesCount

public int valuesCount()

Returns:

Count of keyless values of this scope!

Since:

1.2.0

variablesCount

public int variablesCount()

Returns:

Count of variables!

Since:

1.2.0

isEmpty

public boolean isEmpty()

Returns:

True if this scope is completely empty, meaning there are no variables or values.

Since:

1.2.0

getParent

public Scope getParent()

Returns:

The parent scope of this scope or null if this scope has no parent such as default one in file.

Since:

1.2.0

toVarMap

public java.util.LinkedHashMap<java.lang.String,java.lang.Object> toVarMap()

Returns:

LinkedHashMap with variables of this Scope in defined order! Key is a string name of variable and value is its value!
Modifying this map will not affect this Scope object!

Since:

1.2.0

toValList

public java.util.List<java.lang.Object> toValList()

Returns:

ArrayList with independent values of this Scope. These values have nothing to do with values of variables, they are independent! Modifying this list will not affect this Scope object!

Since:

1.2.0

toValArray

public java.lang.Object[] toValArray()

Returns:

Primitive array with independent values of this Scope. These values have nothing to do with values of variables, they are independent! Modifying this list will not affect this Scope object!

Since:

1.2.0